Add keyname-table.h

2005-05-08  Matthias Clasen  <mclasen@redhat.com>

	* gdk/Makefile.am (IGNORE_HFILES): Add keyname-table.h

	* gdk/gdk-sections.txt: Add gdk_cairo_set_source_color,
	gdk_drawable_create_cairo_context and
	gdk_pixbuf_set_as_cairo_source, remove
	gdk_draw_rectangle_alpha_libgtk_only

	* gdk/tmpl/pixbufs.sgml:
	* gdk/tmpl/cursors.sgml: Add long descriptions.

	* gdk/tmpl/events.sgml:
	* gdk/tmpl/dnd.sgml:
	* gdk/tmpl/windows.sgml:
	* gdk/tmpl/pixmaps.sgml:
	* gdk/tmpl/x_interaction.sgml: Small additions.

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 9bc1eb5c2b7fd563694f83eb4c78d4d9026fce5f..8c1f0285bd2e17d7ac9343197bbc852a866f0182 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,21 @@
+2005-05-08  Matthias Clasen  <mclasen@redhat.com>
+
+       * gdk/Makefile.am (IGNORE_HFILES): Add keyname-table.h
+
+       * gdk/gdk-sections.txt: Add gdk_cairo_set_source_color,
+       gdk_drawable_create_cairo_context and
+       gdk_pixbuf_set_as_cairo_source, remove 
+       gdk_draw_rectangle_alpha_libgtk_only
+
+       * gdk/tmpl/pixbufs.sgml: 
+       * gdk/tmpl/cursors.sgml: Add long descriptions.
+       
+       * gdk/tmpl/events.sgml: 
+       * gdk/tmpl/dnd.sgml: 
+       * gdk/tmpl/windows.sgml: 
+       * gdk/tmpl/pixmaps.sgml: 
+       * gdk/tmpl/x_interaction.sgml: Small additions.
+
 2005-05-07  Matthias Clasen  <mclasen@redhat.com>
 
        * gdk/tmpl/pango_interaction.sgml: Fix a reference.

diff --git a/docs/reference/gdk/Makefile.am b/docs/reference/gdk/Makefile.am
index 92b2cfd2773fbe6b7a675993c5d7e1e6452994cd..7600c9820c69251efde0710523513a841bf64401 100644 (file)
--- a/docs/reference/gdk/Makefile.am
+++ b/docs/reference/gdk/Makefile.am
@@ -28,6 +28,7 @@ IGNORE_HFILES=                        \
        gdkprivate.h            \
        gdkpoly-generic.h       \
        gdkregion-generic.h     \
+       keyname-table.h         \
        linux-fb                \
        nanox                   \
        win32                   \

diff --git a/docs/reference/gdk/gdk-sections.txt b/docs/reference/gdk/gdk-sections.txt
index cbba5c3b23e402ea5c74f2ce6f4e2d214bc3108f..10f911d383edfa31f5f93e9a758dea4abd083f90 100644 (file)
--- a/docs/reference/gdk/gdk-sections.txt
+++ b/docs/reference/gdk/gdk-sections.txt
@@ -343,6 +343,7 @@ gdk_pixbuf_render_pixmap_and_mask
 gdk_pixbuf_render_pixmap_and_mask_for_colormap
 gdk_pixbuf_get_from_drawable
 gdk_pixbuf_get_from_image
+gdk_pixbuf_set_as_cairo_source
 </SECTION>
 
 <SECTION>
@@ -374,6 +375,7 @@ gdk_color_alloc
 gdk_color_change
 gdk_color_equal
 gdk_color_hash
+gdk_cairo_set_source_color
 
 <SUBSECTION Standard>
 GDK_COLORMAP
@@ -453,6 +455,7 @@ gdk_drawable_get_depth
 gdk_drawable_get_size
 gdk_drawable_get_clip_region
 gdk_drawable_get_visible_region
+gdk_drawable_create_cairo_context
 
 <SUBSECTION>
 gdk_draw_point
@@ -496,7 +499,6 @@ GDK_IS_DRAWABLE_CLASS
 <SUBSECTION Private>
 GdkDrawableClass
 gdk_draw_bitmap
-gdk_draw_rectangle_alpha_libgtk_only
 </SECTION>
 
 <SECTION>

diff --git a/docs/reference/gdk/tmpl/cursors.sgml b/docs/reference/gdk/tmpl/cursors.sgml
index eb4442a109664ed1c4cff6644a3d27c03c22e28f..7f12bd92baa4bafc992bf362d027c2e4a5d90b26 100644 (file)
--- a/docs/reference/gdk/tmpl/cursors.sgml
+++ b/docs/reference/gdk/tmpl/cursors.sgml
@@ -6,7 +6,21 @@ Standard and pixmap cursors
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+These functions are used to create and destroy cursors.
+There is a number of standard cursors, but it is also
+possible to construct new cursors from pixmaps and
+pixbufs. There may be limitations as to what kinds of
+cursors can be constructed on a given display, see
+gdk_display_supports_cursor_alpha(), 
+gdk_display_supports_cursor_color(),
+gdk_display_get_default_cursor_size() and
+gdk_display_get_maximal_cursor_size().
+</para>
+<para>
+Cursors by themselves are not very interesting, they must be be
+bound to a window for users to see them. This is done with 
+gdk_window_set_cursor() or by setting the cursor member of the
+#GdkWindowAttr struct passed to gdk_window_new().
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
@@ -14,13 +28,15 @@ Standard and pixmap cursors
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
 <!-- ##### STRUCT GdkCursor ##### -->
 <para>
 A <type>GdkCursor</type> structure represents a cursor.
 </para>
 
-@type: 
-@ref_count: 
+@type: the #GdkCursorType of the cursor
 
 <!-- ##### ENUM GdkCursorType ##### -->
 <para>
@@ -104,9 +120,9 @@ The standard cursors available.
 @GDK_UR_ANGLE: <inlinegraphic format="PNG" fileref="ur_angle.png"></inlinegraphic>
 @GDK_WATCH: <inlinegraphic format="PNG" fileref="watch.png"></inlinegraphic>
 @GDK_XTERM: <inlinegraphic format="PNG" fileref="xterm.png"></inlinegraphic>
-@GDK_LAST_CURSOR: 
+@GDK_LAST_CURSOR: last cursor type
 @GDK_CURSOR_IS_PIXMAP: type of cursors constructed with 
-    gdk_cursor_new_from_pixmap().
+gdk_cursor_new_from_pixmap() or gdk_cursor_new_from_pixbuf()
 
 <!-- ##### FUNCTION gdk_cursor_new ##### -->
 <para>

diff --git a/docs/reference/gdk/tmpl/dnd.sgml b/docs/reference/gdk/tmpl/dnd.sgml
index 4dfdcc05135c617116860ee72c856f2a146ca92f..9ab6a702c89a5bc285aca688e7f6baef67d84b08 100644 (file)
--- a/docs/reference/gdk/tmpl/dnd.sgml
+++ b/docs/reference/gdk/tmpl/dnd.sgml
@@ -22,6 +22,9 @@ the GTK+ documentation for more information.
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
 <!-- ##### FUNCTION gdk_drag_get_selection ##### -->
 <para>
 </para>
@@ -194,7 +197,7 @@ Used in #GdkDragContext to indicate what the destination
 should do with the dropped data.
 </para>
 
-@GDK_ACTION_DEFAULT: 
+@GDK_ACTION_DEFAULT: Means nothing, and should not be used.
 @GDK_ACTION_COPY: Copy the data.
 @GDK_ACTION_MOVE: Move the data, i.e. first copy it, then delete
   it from the source using the DELETE target of the X selection protocol.

diff --git a/docs/reference/gdk/tmpl/events.sgml b/docs/reference/gdk/tmpl/events.sgml
index 941c4e5ceabd095fc9f504a69c20316e4c863b68..2922f73499d3bb0eb7ef164b725a493cdd8e00c8 100644 (file)
--- a/docs/reference/gdk/tmpl/events.sgml
+++ b/docs/reference/gdk/tmpl/events.sgml
@@ -27,6 +27,9 @@ The structs used for each type of event.
 </variablelist>
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
 <!-- ##### ENUM GdkEventType ##### -->
 <para>
 Specifies the type of the event.
@@ -81,9 +84,10 @@ has changed.
 @GDK_VISIBILITY_NOTIFY: the window visibility status has changed.
 @GDK_NO_EXPOSE: indicates that the source region was completely available
 when parts of a drawable were copied. This is not very useful.
-@GDK_SCROLL: 
-@GDK_WINDOW_STATE: 
-@GDK_SETTING: 
+@GDK_SCROLL: the scroll wheel was turned
+@GDK_WINDOW_STATE: the state of a window has changed. See #GdkWindowState
+for the possible window states
+@GDK_SETTING: a setting has been modified. 
 @GDK_OWNER_CHANGE: the owner of a selection has changed. This event type
   was added in 2.6
 

diff --git a/docs/reference/gdk/tmpl/pixbufs.sgml b/docs/reference/gdk/tmpl/pixbufs.sgml
index e1b5547dd1964d5bdc9a705490174a88ff92c651..0098118e3e0eebb32d4790fb849a2ceb3eb96f80 100644 (file)
--- a/docs/reference/gdk/tmpl/pixbufs.sgml
+++ b/docs/reference/gdk/tmpl/pixbufs.sgml
@@ -6,7 +6,9 @@ Functions for rendering pixbufs on drawables
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+These functions allow to render pixbufs on drawables. Pixbufs are
+client-side images. For details on how to create and manipulate
+pixbufs, see the #GdkPixbuf API documentation.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
@@ -14,6 +16,9 @@ Functions for rendering pixbufs on drawables
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
 <!-- ##### FUNCTION gdk_pixbuf_render_threshold_alpha ##### -->
 <para>
 
@@ -126,3 +131,14 @@ Functions for rendering pixbufs on drawables
 @Returns: 
 
 
+<!-- ##### FUNCTION gdk_pixbuf_set_as_cairo_source ##### -->
+<para>
+
+</para>
+
+@pixbuf: 
+@cr: 
+@pixbuf_x: 
+@pixbuf_y: 
+
+

diff --git a/docs/reference/gdk/tmpl/pixmaps.sgml b/docs/reference/gdk/tmpl/pixmaps.sgml
index 18463f6503cff1ddf1462165d9c857ea2a162369..5ea7f8aac8d8c9b511c4f510e4f41b656de6d1de 100644 (file)
--- a/docs/reference/gdk/tmpl/pixmaps.sgml
+++ b/docs/reference/gdk/tmpl/pixmaps.sgml
@@ -18,6 +18,9 @@ pixel can be either on or off).
 <para>
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
 <!-- ##### STRUCT GdkPixmap ##### -->
 <para>
 An opaque structure representing an offscreen drawable.

diff --git a/docs/reference/gdk/tmpl/windows.sgml b/docs/reference/gdk/tmpl/windows.sgml
index e3d1de59a39f207ab58318950771cd17eb0b7a23..0850dd820831adde85e26fca64b43e8e2e55328a 100644 (file)
--- a/docs/reference/gdk/tmpl/windows.sgml
+++ b/docs/reference/gdk/tmpl/windows.sgml
@@ -18,6 +18,9 @@ For example, each #GtkButton has a #GdkWindow associated with it.
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
 <!-- ##### STRUCT GdkWindow ##### -->
 <para>
 An opaque structure representing an onscreen drawable.
@@ -273,7 +276,7 @@ corresponding flag in #GdkWindowAttributesType.
 Deprecated equivalent of g_object_ref()
 </para>
 
-@Returns: 
+@Returns: the window
 
 
 <!-- ##### MACRO gdk_window_unref ##### -->
@@ -1075,7 +1078,7 @@ Deprecated equivalent of gdk_drawable_get_size().
 Deprecated equivalent of gdk_drawable_get_visual().
 </para>
 
-@Returns: 
+@Returns: the #GdkVisual of the window
 
 
 <!-- ##### MACRO gdk_window_get_colormap ##### -->

diff --git a/docs/reference/gdk/tmpl/x_interaction.sgml b/docs/reference/gdk/tmpl/x_interaction.sgml
index 82ab674858a5e0c9f63f17853bd217be6e5ce9e3..a04ac0e8cc3e58ff9e94e85997fa386543462b2d 100644 (file)
--- a/docs/reference/gdk/tmpl/x_interaction.sgml
+++ b/docs/reference/gdk/tmpl/x_interaction.sgml
@@ -14,6 +14,9 @@ X backend-specific functions
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
 <!-- ##### MACRO GDK_ROOT_WINDOW ##### -->
 <para>
 Obtains the Xlib window id of the root window of the current screen. 
@@ -59,10 +62,8 @@ Returns the X window belonging to a #GdkWindow.
 Returns the display of a #GdkPixmap.
 </para>
 
-@pix: 
+@pix: a #GdkPixmap.
 @Returns: an Xlib <type>Display*</type>.
-<!-- # Unused Parameters # -->
-@win: a #GdkPixmap.
 
 
 <!-- ##### MACRO GDK_PIXMAP_XID ##### -->
@@ -70,10 +71,8 @@ Returns the display of a #GdkPixmap.
 Returns the X pixmap belonging to a #GdkPixmap.
 </para>
 
-@pix: 
+@pix: a #GdkPixmap.
 @Returns: the Xlib <type>XPixmap</type> of @win.
-<!-- # Unused Parameters # -->
-@win: a #GdkPixmap.
 
 
 <!-- ##### MACRO GDK_DISPLAY_XDISPLAY ##### -->